home *** CD-ROM | disk | FTP | other *** search
/ Aminet 7 / Aminet 7 - August 1995.iso / Aminet / util / misc / AmInUp.lha / AmInUp.doc < prev   
Text File  |  1995-05-02  |  5KB  |  114 lines
  1.     ===========================================================
  2.     ==                                                       ==
  3.     ==               A m I n U p      v1.0                   ==
  4.     ==                                                       ==
  5.     ==         (Aminet Indexes Updating utility)             ==
  6.     ==                                                       ==
  7.     ==        FREEWARE by Emanuele Bolognesi 1995            ==
  8.     ==                                                       ==
  9.     ===========================================================
  10.  
  11.  
  12.   AmInUp is FREEWARE, but you  may not copy and/or  distribute this program 
  13.   without the accompanying documentation unless you get permission from the 
  14.   author to do so.
  15.  
  16.   This  product is  sold  "as is"  without  representation or  warranty  of
  17.   any  kind, either  expressed or implied. The user  assumes all  risks and
  18.   responsibilities related to its use.
  19.  
  20.  
  21. INTRODUCTION
  22.  This  utility is very  useful if you  are used to print your Aminet indexes.
  23. Let's suppose you have downloaded a big INDEX (e.g. util/INDEX or game/INDEX) 
  24. and you  have printed it  with  your fantastic printer.  Then, 1/2/3... weeks 
  25. later, you  download the same index another time.  It has, obviously, changed 
  26. and you  have two choices:  reprint it completely, spending  precious ink and 
  27. paper, or..... use AmInUp updating the old print!
  28.  
  29.  
  30. USAGE:    AmInUp <newindex> <oldindex>  [SAMEDIRS] [NOTITLE]
  31.  
  32. AmInUp extracts from <newindex> all the lines not present in <oldindex>.
  33. So, if you  print  these lines,  you  can add  some  pages to  the old index, 
  34. updating it. Unfortunately, the print is no more in alphabetic order, but you 
  35. have spared time and expense.
  36.  
  37. Remember: AmInUp works with Aminet indexes only!
  38.  
  39.  
  40. NOTE FOR NON-GURUS:
  41. AmInUp must be used from the CLI (Shell).
  42. Output goes to the StandardOutput (i.e. the CLI window) but you can redirect
  43. it by adding a ">" at the end of the command line.
  44.  
  45. "AmInUp NewIndex OldIndex >PRT:"   --> extracted lines will be printed.
  46.  
  47. "AmInUp NewIndex OldIndex >myfile" --> a new file "myfile", containing the
  48.                                        extracted lines, will be created.  
  49.  
  50.  
  51. OPTIONS:
  52. 1- If you  specify "SAMEDIRS",  AmInUp  does  not  extract lines  containing
  53.  directories not present in <oldindex>.
  54.  Ex. If your old index is "game/INDEX" and it lists these directories: 
  55.  game/2play, game/demo, game/gag, game/hint etc... and your new "game/INDEX" 
  56.  contains these directories: game/2play, game/board, game/demo etc.., AmInUp 
  57.  does not extract lines regarding "game/board".
  58.  The most  useful application  of this option is to  allow you to  update an 
  59.  index using a more general index. 
  60.  Ex. If you have  printed "game/shoot/INDEX" and then  you have downloaded a 
  61.  more recent game/INDEX you can see all the new uploads to game/shoot with:
  62.  
  63.    AmInUp 'game_INDEX' 'game_shoot_INDEX' SAMEDIRS  
  64.    
  65.  Only lines  containing the directory  "game/shoot"  will be  extracted from
  66.  'game_INDEX', and only those not present in your old 'game_shoot_INDEX'.
  67.  
  68. 2- Normally AmInUp writes a little header at the beginning of the new index
  69.  it produces; if you specify 'NOTITLE', this header will be omitted.
  70.   
  71.  As you know, every Aminet INDEX has 2 lines at the beginning:
  72.  
  73. " | Contents of the directory 'DIRECTORY' : 'directory description'
  74.   |--------------------------------------------------------------------- "
  75.  
  76.  
  77.  AmInUp writes these lines (if you don't specify 'NOTITLE'): 
  78.    
  79. " | UpDate of the directory 'DIRECTORY'     Date:
  80.   |--------------------------------------------------------------------- "
  81.    
  82.  The string 'DIRECTORY' is taken from <oldindex> (from its header).
  83.    
  84.  The  date is not  written, since AmInUp  couldn't know  when you have down-
  85.  loaded <newindex>. If you print directly the update you can add the date by
  86.  hand, or if you  redirect the  output to a file, you can add it with a text 
  87.  editor. 
  88.  
  89. IMPORTANT: AmInUp checks the presence of the Aminet header (both 2 lines) at
  90. the beginning  of <newindex>  and  <oldindex>, if it can't find it, an error 
  91. will  be reported:  "Files are not Aminet indexes".  The  header  written by 
  92. AmInUp  ( "UpDate of ...." ) goes well too.  So AmInUp  can work with  files 
  93. generated by itself, if you don't specify NOTITLE.   
  94.  
  95.  
  96.  
  97.  This is a simple program, but very useful (at least for me). 
  98.  If you find some bugs (impossible...) or if you have some suggestions,
  99.  please contact me by e-mail.
  100.  Bye!
  101.  
  102.  
  103. === AUTHOR: =====================================
  104.  
  105.             EMANUELE BOLOGNESI
  106.            
  107.   address:  Via Marzocco 45
  108.             57011 Castelnuovo M. (LI)
  109.             ITALY
  110.  
  111.   e-mail:   bolognes@cli.di.unipi.it
  112.  
  113. =================================================     
  114.